<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class REXML::Entity - rexml: Ruby Standard Library Documentation</title>


<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>

<script src="../js/jquery-3.2.0.min.js"></script>

<script src="../js/vue.min.js"></script>
<script src="../js/js.cookie.min.js"></script>

<link href="../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../css/rdoc.css" rel="stylesheet">
<link href="../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
  var index_rel_prefix = "../";
  var darkModeCsseHref = "../css/rdoc-dm.css"
  var defaultModeCssHref = "../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="Child.html">REXML::Child</a>
</div>

        
<div id="includes-section" class="nav-section">
  <h3>Included Modules</h3>

  <ul class="link-list">
    <li><a class="include" href="XMLTokens.html">REXML::XMLTokens</a>
  </ul>
</div>

        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-matches-3F">::matches?</a>
    <li class="calls-super" ><a href="#method-c-new">::new</a>
    <li ><a href="#method-i-normalized">#normalized</a>
    <li class="calls-super" ><a href="#method-i-parent-3D">#parent=</a>
    <li ><a href="#method-i-resolve_value">#resolve_value</a>
    <li ><a href="#method-i-to_s">#to_s</a>
    <li ><a href="#method-i-unnormalized">#unnormalized</a>
    <li ><a href="#method-i-value">#value</a>
    <li ><a href="#method-i-write">#write</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-REXML::Entity">
    <h1 id="class-REXML::Entity" class="class">
      class REXML::Entity
    </h1>

    <section class="description">
    
    </section>

      <section id="5Buntitled-5D" class="documentation-section">


      <section class="constants-list">
      <header>
      <h3>Constants</h3>
      </header>
      <dl>
          <dt id="ENTITYDECL">ENTITYDECL
          <dd>
          <dt id="ENTITYDEF">ENTITYDEF
          <dd>
          <dt id="ENTITYVALUE">ENTITYVALUE
          <dd>
          <dt id="EXTERNALID">EXTERNALID
          <dd>
          <dt id="GEDECL">GEDECL
          <dd>
          <dt id="NDATADECL">NDATADECL
          <dd>
          <dt id="PEDECL">PEDECL
          <dd>
          <dt id="PEDEF">PEDEF
          <dd>
          <dt id="PEREFERENCE">PEREFERENCE
          <dd>
          <dt id="PEREFERENCE_RE">PEREFERENCE_RE
          <dd>
          <dt id="PUBIDCHAR">PUBIDCHAR
          <dd>
          <dt id="PUBIDLITERAL">PUBIDLITERAL
          <dd>
          <dt id="SYSTEMLITERAL">SYSTEMLITERAL
          <dd>
        </dl>
        </section>

        <section class="attribute-method-details" class="method-section">
        <header>
        <h3>Attributes</h3>
        </header>

          <div id="attribute-i-external" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">external</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
          <div id="attribute-i-name" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">name</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
          <div id="attribute-i-ndata" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">ndata</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
          <div id="attribute-i-pubid" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">pubid</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
          <div id="attribute-i-ref" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">ref</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
            </section>


                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-matches-3F" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">matches?</span><span
                                class="method-args">(string)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Evaluates whether the given string matches an entity definition, returning true if so, and false otherwise.</p>

                              <div class="method-source-code" id="matches-3F-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Entity</span><span class="ruby-operator">::</span><span class="ruby-identifier ruby-title">matches?</span> <span class="ruby-identifier">string</span>
  (<span class="ruby-constant">ENTITYDECL</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">string</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-c-new" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">new</span><span
                                class="method-args">(stream, value=nil, parent=nil, reference=false)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Create a new entity.  Simple entities can be constructed by passing a name, value to the constructor; this creates a generic, plain entity reference. For anything more complicated, you have to pass a <a href="Source.html"><code>Source</code></a> to the constructor with the entity definition, or use the accessor methods. <code>WARNING</code>: There is no validation of entity state except when the entity is read from a stream.  If you start poking around with the accessors, you can easily create a non-conformant <a href="Entity.html"><code>Entity</code></a>.</p>

<pre class="ruby"><span class="ruby-identifier">e</span> = <span class="ruby-constant">Entity</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">&#39;amp&#39;</span>, <span class="ruby-string">&#39;&amp;&#39;</span> )
</pre>
                                <div class="method-calls-super">
                                  Calls superclass method
                                  <a href="Child.html#method-c-new"><code>REXML::Child::new</code></a>
                              </div>

                              <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">stream</span>, <span class="ruby-identifier">value</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">parent</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reference</span>=<span class="ruby-keyword">false</span>
  <span class="ruby-keyword">super</span>(<span class="ruby-identifier">parent</span>)
  <span class="ruby-ivar">@ndata</span> = <span class="ruby-ivar">@pubid</span> = <span class="ruby-ivar">@value</span> = <span class="ruby-ivar">@external</span> = <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Array</span>
    <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">1</span>]
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-string">&#39;%&#39;</span>
      <span class="ruby-ivar">@reference</span> = <span class="ruby-keyword">true</span>
      <span class="ruby-identifier">stream</span>.<span class="ruby-identifier">pop</span>
    <span class="ruby-keyword">else</span>
      <span class="ruby-ivar">@reference</span> = <span class="ruby-keyword">false</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/SYSTEM|PUBLIC/</span>
      <span class="ruby-ivar">@external</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>]
      <span class="ruby-keyword">if</span> <span class="ruby-ivar">@external</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;SYSTEM&#39;</span>
        <span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">3</span>]
        <span class="ruby-ivar">@ndata</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">4</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">5</span>
      <span class="ruby-keyword">else</span>
        <span class="ruby-ivar">@pubid</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">3</span>]
        <span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">4</span>]
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">else</span>
      <span class="ruby-ivar">@value</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>]
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-ivar">@reference</span> = <span class="ruby-identifier">reference</span>
    <span class="ruby-ivar">@external</span> = <span class="ruby-keyword">nil</span>
    <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">stream</span>
    <span class="ruby-ivar">@value</span> = <span class="ruby-identifier">value</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-normalized" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">normalized</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns the value of this entity unprocessed – raw.  This is the normalized value; that is, with all %ent; and &amp;ent; entities intact</p>

                              <div class="method-source-code" id="normalized-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">normalized</span>
  <span class="ruby-ivar">@value</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-parent-3D" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">parent=</span><span
                                class="method-args">(other)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              
                                <div class="method-calls-super">
                                  Calls superclass method
                                  <a href="Child.html#method-i-parent-3D"><code>REXML::Child#parent=</code></a>
                              </div>

                              <div class="method-source-code" id="parent-3D-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parent=</span>(<span class="ruby-identifier">other</span>)
  <span class="ruby-ivar">@resolved_value</span> = <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-to_s" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">to_s</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns this entity as a string.  See write().</p>

                              <div class="method-source-code" id="to_s-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
  <span class="ruby-identifier">rv</span> = <span class="ruby-string">&#39;&#39;</span>
  <span class="ruby-identifier">write</span> <span class="ruby-identifier">rv</span>
  <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-unnormalized" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">unnormalized</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Evaluates to the unnormalized value of this entity; that is, replacing all entities – both %ent; and &amp;ent; entities.  This differs from +value()+ in that <code>value</code> only replaces %ent; entities.</p>

                              <div class="method-source-code" id="unnormalized-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unnormalized</span>
  <span class="ruby-identifier">document</span>.<span class="ruby-identifier">record_entity_expansion</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">document</span>.<span class="ruby-identifier">nil?</span>
  <span class="ruby-identifier">v</span> = <span class="ruby-identifier">value</span>()
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
  <span class="ruby-ivar">@unnormalized</span> = <span class="ruby-constant">Text</span><span class="ruby-operator">::</span><span class="ruby-identifier">unnormalize</span>(<span class="ruby-identifier">v</span>, <span class="ruby-identifier">parent</span>)
  <span class="ruby-ivar">@unnormalized</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-value" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">value</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns the value of this entity.  At the moment, only internal entities are processed.  If the value contains internal references (IE, %blah;), those are replaced with their values.  IE, if the doctype contains:</p>

<pre>&lt;!ENTITY % foo &quot;bar&quot;&gt;
&lt;!ENTITY yada &quot;nanoo %foo; nanoo&gt;</pre>

<p>then:</p>

<pre class="ruby"><span class="ruby-identifier">doctype</span>.<span class="ruby-identifier">entity</span>(<span class="ruby-string">&#39;yada&#39;</span>).<span class="ruby-identifier">value</span>   <span class="ruby-comment">#-&gt; &quot;nanoo bar nanoo&quot;</span>
</pre>

                              <div class="method-source-code" id="value-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value</span>
  <span class="ruby-ivar">@resolved_value</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">resolve_value</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-write" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">write</span><span
                                class="method-args">(out, indent=-1)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Write out a fully formed, correct entity definition (assuming the <a href="Entity.html"><code>Entity</code></a> object itself is valid.)</p>
<dl class="rdoc-list note-list"><dt>out
<dd>
<p>An object implementing <code>&amp;lt;&amp;lt;</code> to which the entity will be output</p>
</dd><dt>indent
<dd>
<p><strong>DEPRECATED</strong> and ignored</p>
</dd></dl>

                              <div class="method-source-code" id="write-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span> <span class="ruby-identifier">out</span>, <span class="ruby-identifier">indent</span>=<span class="ruby-value">-1</span>
  <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39;&lt;!ENTITY &#39;</span>
  <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39;% &#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@reference</span>
  <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@name</span>
  <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39; &#39;</span>
  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@external</span>
    <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@external</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39; &#39;</span>
    <span class="ruby-keyword">if</span> <span class="ruby-ivar">@pubid</span>
      <span class="ruby-identifier">q</span> = <span class="ruby-ivar">@pubid</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">&#39;&quot;&#39;</span>)<span class="ruby-operator">?</span><span class="ruby-string">&quot;&#39;&quot;</span><span class="ruby-operator">:</span><span class="ruby-string">&#39;&quot;&#39;</span>
      <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@pubid</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39; &#39;</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">q</span> = <span class="ruby-ivar">@ref</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">&#39;&quot;&#39;</span>)<span class="ruby-operator">?</span><span class="ruby-string">&quot;&#39;&quot;</span><span class="ruby-operator">:</span><span class="ruby-string">&#39;&quot;&#39;</span>
    <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@ref</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span>
    <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39; NDATA &#39;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@ndata</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@ndata</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">q</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">&#39;&quot;&#39;</span>)<span class="ruby-operator">?</span><span class="ruby-string">&quot;&#39;&quot;</span><span class="ruby-operator">:</span><span class="ruby-string">&#39;&quot;&#39;</span>
    <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">q</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&#39;&gt;&#39;</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Private Instance Methods</h3>
                </header>

                  <div id="method-i-resolve_value" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">resolve_value</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="resolve_value-source">
            <pre><span class="ruby-comment"># File rexml-3.2.6/lib/rexml/entity.rb, line 144</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">resolve_value</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">nil?</span>
  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@value</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-constant">PEREFERENCE_RE</span>)

  <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-constant">PEREFERENCE_RE</span>)
  <span class="ruby-identifier">rv</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">clone</span>
  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span>
    <span class="ruby-identifier">sum</span> = <span class="ruby-value">0</span>
    <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entity_reference</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">entity_value</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">entity</span>( <span class="ruby-identifier">entity_reference</span>[<span class="ruby-value">0</span>] )
      <span class="ruby-keyword">if</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">entity_value</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">&gt;</span> <span class="ruby-constant">Security</span>.<span class="ruby-identifier">entity_expansion_text_limit</span>
        <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;entity expansion has grown too large&quot;</span>
      <span class="ruby-keyword">else</span>
        <span class="ruby-identifier">sum</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">entity_value</span>.<span class="ruby-identifier">bytesize</span>
      <span class="ruby-keyword">end</span>
      <span class="ruby-identifier">rv</span>.<span class="ruby-identifier">gsub!</span>( <span class="ruby-regexp">/%#{entity_reference.join};/um</span>, <span class="ruby-identifier">entity_value</span> )
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is a service of <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>, purveyors of fine <a href='https://jamesbritt.bandcamp.com/'>dance noise</a></p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

